feat: Update Search component to support i18n #1192
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…as Button text, update with test checking for ability to pass label, update stories with Spanish examples to match USWDS
SirenaBorracha
requested review from
ahobson,
brandonlenz,
gidjin,
haworku,
sarboc,
suzubara and
tinyels
as code owners
brandonlenz
reviewed
Apr 28, 2021
| @@ -73,7 +73,7 @@ export const Search = ({ | |||
| /> | |||
| <Button type="submit"> | |||
| <span className={isSmall ? 'usa-sr-only' : 'usa-search__submit-text'}> | |||
| Search | |||
There was a problem hiding this comment.
So while this works and may be perfectly acceptable, I can see a use case where someone may want to the Button text to be different from the label.
There's also the thought of following convention for localizations which we established in #990. There we added an i18n object prop which contained all the localization values. Since we only have one value to worry about here, that might feel like a bit much.
My overall preference with this is to follow convention, even if it feels like overkill, in the name of uniform codebase. Plus, to handle the scenario of wanting label and button text to be different we would have to introduce a new prop anyways, so that would be half way to implementing our established i18n pattern.
brandonlenz
approved these changes
May 4, 2021
| @@ -44,6 +50,8 @@ export const Search = ({ | |||
| deprecationWarning('Search property small is deprecated. Use size') | |||
| } | |||
|
|
|||
| const buttonText = i18n?.buttonText || 'Search' | |||
There was a problem hiding this comment.
If you want, you can even declare a default for i18n (such as the EN_US used in DatePicker). Since this is only one field within i18n, I'm good with it as is.
Merged
SirenaBorracha
added a commit
that referenced
this pull request
May 5, 2021
## [1.17.0](1.16.0...1.17.0) (2021-05-05) ### Features * Checkbox Tile Variant ([#1104](#1104)) ([9936c4a](9936c4a)) * Implement ProcessListHeading subcomponent ([#1162](#1162)) ([964e34c](964e34c)) * New Component ProcessList MVP ([#1107](#1107)) ([1bc0f93](1bc0f93)) * New Component SiteAlert ([#1099](#1099)) ([c1e88e0](c1e88e0)) * New Component SummaryBox ([#1098](#1098)) ([b2279b4](b2279b4)) * Radio Button Tile Variant ([#1101](#1101)) ([a2f40a0](a2f40a0)) * Update Grid components to render any type of element ([#1166](#1166)) ([07468c8](07468c8)), closes [#1194](#1194) * Update Search component to support i18n ([#1192](#1192)) ([5241d15](5241d15)) * Update Table to 2.10.0 implementation ([#1110](#1110)) ([117a6c7](117a6c7))
brandonlenz
pushed a commit
that referenced
this pull request
May 12, 2021
* Update Search component to pass in label instead of hardcoded string as Button text, update with test checking for ability to pass label, update stories with Spanish examples to match USWDS * Simplify localization interface, update test, update Storybook examples
brandonlenz
pushed a commit
that referenced
this pull request
May 12, 2021
## [1.17.0](1.16.0...1.17.0) (2021-05-05) ### Features * Checkbox Tile Variant ([#1104](#1104)) ([9936c4a](9936c4a)) * Implement ProcessListHeading subcomponent ([#1162](#1162)) ([964e34c](964e34c)) * New Component ProcessList MVP ([#1107](#1107)) ([1bc0f93](1bc0f93)) * New Component SiteAlert ([#1099](#1099)) ([c1e88e0](c1e88e0)) * New Component SummaryBox ([#1098](#1098)) ([b2279b4](b2279b4)) * Radio Button Tile Variant ([#1101](#1101)) ([a2f40a0](a2f40a0)) * Update Grid components to render any type of element ([#1166](#1166)) ([07468c8](07468c8)), closes [#1194](#1194) * Update Search component to support i18n ([#1192](#1192)) ([5241d15](5241d15)) * Update Table to 2.10.0 implementation ([#1110](#1110)) ([117a6c7](117a6c7))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This is a quick update to the existing Search component to add support for i18n. I followed the pattern established in the DatePicker component
Related Issues or PRs
closes #1103
How To Test
Check out this branch and run
yarn testto execute tests andyarn storybookto see the component in action.Alternatively, you can scroll to the bottom of this page and click "Show environments" on the right above the comment input box to access this component in Storybook.
Screenshots